package uk.ac.lkl.lpp.ui;



/**
 * A line in the overheads section of a teaching method view.
 * 
 * This class is currently unused. It is intended to be used for the preparation
 * and presentation hours.
 * 
 * @author Darren Pearce
 * @version $Revision$
 * @version $Date$
 * 
 */
public abstract class OverheadLine {

    /**
     * The name of this instance.
     * 
     */
    private String name;


    /**
     * Create a new instance with the given name.
     * 
     * @param name
     *            the name of this instance
     */
    public OverheadLine(String name) {
        this.name = name;
    }


    /**
     * Get the name of this instance.
     * 
     * @return the name
     * 
     */
    public String getName() {
        return name;
    }


    /**
     * Get the start string for this overhead line.
     * 
     * This will be something like 'it takes'.
     * 
     * @return the start string
     * 
     */
    public abstract String getStartString();


    public abstract Float getOverheadHours();


    /**
     * Get the middle string for this instance.
     * 
     * This will be something like 'to prepare'. The text may be
     * teaching-method-specific.
     * 
     * @return the middle string
     * 
     */
    public abstract String getMiddleString();


    /**
     * Get the learner hours for this instance.
     * 
     * @return the learner hours
     * 
     */
    public abstract Float getLearnerHours();


    /**
     * Get the end string.
     * 
     * This will be something like 'lecture' for Lecture, etc.
     * 
     * @return the end string
     * 
     */
    public abstract String getEndString();

}
